Skip to main content

Notification Service

Allow real-time notifications to reach users currently using the roboCAPTCHA web app, alerting them of any blocked robocalls detected by our filtering system or any legitimate human callers that successfully passed our verification.

Makes use of Amazon SQS to receive messages from the roboCAPTCHA service, sends notifications to the user on roboCAPTCHA frontend web app through a WebSocket connection.

Environment Variables

NameDescription
MONGODB_URLConnection string to establish an instance for MongoDB
AWS_SQS_NOTIFICATION_URLURL endpoint that receives messages in AWS Simple Queue Service
AWS_ACCESS_KEY_IDAWS Access Key ID
AWS_SECRET_ACCESS_KEYAWS Secret

Cloning the Repository

git clone https://github.com/phomies/robocaptcha-notification.git

Local Deployment

npm i
npm run start

Local Deployment with Docker Compose

docker-compose up -d --build